IR Sense 6 Click Driver

API for configuring and manipulating IR Sense 6 Click driver. More...

Topics
	IR Sense 6 Commands List
	List of commands of IR Sense 6 Click driver.
	IR Sense 6 Settings
	Settings of IR Sense 6 Click driver.
	IR Sense 6 MikroBUS Map
	MikroBUS pin mapping of IR Sense 6 Click driver.

Functions
void	irsense6_cfg_setup (irsense6_cfg_t *cfg)
	IR Sense 6 configuration object setup function.
err_t	irsense6_init (irsense6_t *ctx, irsense6_cfg_t *cfg)
	IR Sense 6 initialization function.
err_t	irsense6_i2c_write (irsense6_t *ctx, uint8_t *data_in, uint8_t len)
	IR Sense 6 I2C write function.
err_t	irsense6_i2c_read (irsense6_t *ctx, uint8_t *data_out, uint8_t len)
	IR Sense 6 I2C read function.
void	irsense6_enable_device (irsense6_t *ctx)
	IR Sense 6 enable device function.
void	irsense6_disable_device (irsense6_t *ctx)
	IR Sense 6 disable device function.
err_t	irsense6_read_data (irsense6_t *ctx, float *obj_temp, float *amb_temp)
	IR Sense 6 read temperature data function.

Detailed Description

API for configuring and manipulating IR Sense 6 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

irsense6_cfg_setup()

void irsense6_cfg_setup

(

irsense6_cfg_t *

cfg

)

IR Sense 6 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See irsense6_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

irsense6_disable_device()

void irsense6_disable_device

(

irsense6_t *

ctx

)

IR Sense 6 disable device function.

This function disables the IR Sense 6 device by setting the EN pin low.

Parameters

[in]

ctx

: Click context object. See irsense6_t object definition for detailed explanation.

Returns

None.

Note

None.

irsense6_enable_device()

void irsense6_enable_device

(

irsense6_t *

ctx

)

IR Sense 6 enable device function.

This function enables the IR Sense 6 device by setting the EN pin high.

Parameters

[in]

ctx

: Click context object. See irsense6_t object definition for detailed explanation.

Returns

None.

Note

None.

irsense6_i2c_read()

err_t irsense6_i2c_read	(	irsense6_t *	ctx,
		uint8_t *	data_out,
		uint8_t	len )

IR Sense 6 I2C read function.

This function reads data via I2C from the IR Sense 6 device.

Parameters

[in]	ctx	: Click context object. See irsense6_t object definition for detailed explanation.
[out]	data_out	: Data buffer to store read data.
[in]	len	: Number of bytes to read.

Returns

• 0 - Success,
• -1 - Error.

Note

None.

irsense6_i2c_write()

err_t irsense6_i2c_write	(	irsense6_t *	ctx,
		uint8_t *	data_in,
		uint8_t	len )

IR Sense 6 I2C write function.

This function writes data via I2C to the IR Sense 6 device.

Parameters

[in]	ctx	: Click context object. See irsense6_t object definition for detailed explanation.
[in]	data_in	: Data buffer to be written.
[in]	len	: Number of bytes to write.

Returns

• 0 - Success,
• -1 - Error.

Note

None.

irsense6_init()

err_t irsense6_init	(	irsense6_t *	ctx,
		irsense6_cfg_t *	cfg )

IR Sense 6 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See irsense6_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See irsense6_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

irsense6_read_data()

err_t irsense6_read_data	(	irsense6_t *	ctx,
		float *	obj_temp,
		float *	amb_temp )

IR Sense 6 read temperature data function.

This function reads the object and ambient temperature data from the IR Sense 6 sensor.

Parameters

[in]	ctx	: Click context object. See irsense6_t object definition for detailed explanation.
[out]	obj_temp	: Pointer to store the object temperature in degrees Celsius.
[out]	amb_temp	: Pointer to store the ambient temperature in degrees Celsius.

Returns

• 0 - Success,
• -1 - Error.

Note

None.